/*
 * Copyright (C) 2024 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @addtogroup CryptoDigestApi
 * @{
 *
 * @brief 为应用提供摘要算法接口。
 *
 * @since 12
 */

/**
 * @file crypto_digest.h
 *
 * @brief 定义摘要算法API。
 *
 * @library libohcrypto.so
 * @include <CryptoArchitectureKit/crypto_digest.h>
 * @kit CryptoArchitectureKit
 * @syscap SystemCapability.Security.CryptoFramework
 * @since 12
 */

#ifndef CRYPTO_DIGEST_H
#define CRYPTO_DIGEST_H

#include "crypto_common.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief 定义摘要结构体。
 *
 * @since 12
 */
typedef struct OH_CryptoDigest OH_CryptoDigest;

/**
 * @brief 根据给定的算法名称创建一个摘要实例。
 *
 * @param algoName 用于生成摘要实例的算法名称。\n
 * 例如"SHA256"。
 * @param ctx 指向摘要实例的指针。
 * @return CRYPTO_SUCCESS：操作成功。\n
 *         CRYPTO_INVALID_PARAMS：参数无效。\n
 *         CRYPTO_NOT_SUPPORTED：操作不支持。\n
 *         CRYPTO_MEMORY_ERROR：内存错误。\n
 *         CRYPTO_OPERTION_ERROR：调用三方算法库API出错。
 * @since 12
 */
OH_Crypto_ErrCode OH_CryptoDigest_Create(const char *algoName, OH_CryptoDigest **ctx);

/**
 * @brief 更新摘要数据。
 *
 * @param ctx 指向摘要实例。
 * @param in 传入的消息。
 * @return CRYPTO_SUCCESS：操作成功。\n
 *         CRYPTO_INVALID_PARAMS：参数无效。\n
 *         CRYPTO_NOT_SUPPORTED：操作不支持。\n
 *         CRYPTO_MEMORY_ERROR：内存错误。\n
 *         CRYPTO_OPERTION_ERROR：调用三方算法库API出错。
 * @see OH_CryptoDigest_Final
 * @since 12
 */
OH_Crypto_ErrCode OH_CryptoDigest_Update(OH_CryptoDigest *ctx, Crypto_DataBlob *in);

/**
 * @brief 完成摘要计算。
 *
 * @param ctx 指向摘要实例。
 * @param out 返回的Md的计算结果。
 * @return CRYPTO_SUCCESS：操作成功。\n
 *         CRYPTO_INVALID_PARAMS：参数无效。\n
 *         CRYPTO_NOT_SUPPORTED：操作不支持。\n
 *         CRYPTO_MEMORY_ERROR：内存错误。\n
 *         CRYPTO_OPERTION_ERROR：调用三方算法库API出错。
 * @see OH_CryptoDigest_Update
 * @since 12
 */
OH_Crypto_ErrCode OH_CryptoDigest_Final(OH_CryptoDigest *ctx, Crypto_DataBlob *out);

/**
 * @brief 获取摘要长度。
 *
 * @param ctx 指向摘要实例。
 * @return 返回摘要长度。\n
 *        如果输入参数ctx为NULL，则返回401，其他情况下返回0。
 * @since 12
 */
uint32_t OH_CryptoDigest_GetLength(OH_CryptoDigest *ctx);

/**
 * @brief 获取摘要算法名称。
 *
 * @param ctx 指向摘要实例。
 * @return 返回摘要算法名称。
 * @since 12
 */
const char *OH_CryptoDigest_GetAlgoName(OH_CryptoDigest *ctx);

/**
 * @brief 销毁摘要实例。
 *
 * @param ctx 指向摘要实例。
 * 
 * @since 12
 */
void OH_DigestCrypto_Destroy(OH_CryptoDigest *ctx);

#ifdef __cplusplus
}
#endif

/** @} */
#endif /* CRYPTO_DIGEST_H */